Koala Plot Core/io.github.koalaplot.core.polar

Package-level declarations

Types

An interface for classes representing the angular axis on a polar plot.

data class AngularValueAxisModel(tickValues: List<AngularValue> = buildList { @Suppress("MagicNumber") for (i in 0..<8) { add((PI * i / 4.0).rad) } }, val angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.COUNTERCLOCKWISE, val angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.THREE_OCLOCK) : AngularAxisModel<AngularValue>

An AngularAxisModel that uses AngularValues of either Radians or Degrees.

CategoryAngularAxisModel

data class CategoryAngularAxisModel<T>(categories: List<T>, val angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.CLOCKWISE, val angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.TWELVE_OCLOCK) : AngularAxisModel<T>

An AngularAxisModel that uses category values evenly spaced around the perimeter of the Polar plot. Values plotted on this axis can only exactly match one of the category values.

DefaultPolarPoint

data class DefaultPolarPoint<R, T>(val r: R, val theta: T) : PolarPoint<R, T>

Default implementation of the PolarPoint interface.

FloatRadialAxisModel

class FloatRadialAxisModel(val tickValues: List<Float>) : RadialAxisModel<Float>

A model for a radial axis that uses Float values and is linear.

PolarGraphDefaults

object PolarGraphDefaults

Contains default values for PolarGraphs.

PolarGraphProperties

data class PolarGraphProperties(val radialGridType: RadialGridType, val radialAxisGridLineStyle: LineStyle?, val angularAxisGridLineStyle: LineStyle?, val angularLabelGap: Dp, val radialLabelGap: Dp, val background: AreaStyle?)

Properties used to customize the visuals and layout of a PolarGraph.

PolarGraphScope

interface PolarGraphScope<T> : HoverableElementAreaScope

Scope for plot series content placed on a PolarGraph.

PolarPoint

interface PolarPoint<R, T>

Represents a point on a 2-d polar plot.

RadialAxisModel

interface RadialAxisModel<T>

A model for a radial axis that transforms from axis space to drawing space.

RadialGridType

enum RadialGridType : Enum<RadialGridType>

An enum class to specify how the radial axis grid lines are drawn. CIRCLES will draw the grid lines as concentric circles of different radii, whereas LINES will draw them as straight lines between consecutive angular axis grid lines.

Functions

PolarGraph

@Composable

fun <T> PolarGraph(radialAxisModel: FloatRadialAxisModel, angularAxisModel: AngularAxisModel<T>, radialAxisLabelText: (Float) -> String = { it.toString() }, angularAxisLabelText: (T) -> String = { it.toString() }, modifier: Modifier = Modifier, polarGraphProperties: PolarGraphProperties = PolarGraphDefaults.PolarGraphPropertyDefaults(), content: @Composable PolarGraphScope<T>.() -> Unit)

@Composable

fun <T> PolarGraph(radialAxisModel: FloatRadialAxisModel, angularAxisModel: AngularAxisModel<T>, radialAxisLabels: @Composable (Float) -> Unit, angularAxisLabels: @Composable (T) -> Unit, modifier: Modifier = Modifier, polarGraphProperties: PolarGraphProperties = PolarGraphDefaults.PolarGraphPropertyDefaults(), content: @Composable PolarGraphScope<T>.() -> Unit)

A Graph using polar coordinates - a radial axis and an angular axis. Multiple series of data can be plotted on a polar graph as lines and/or shaded regions with or without symbols at each plotted point.

PolarPlotSeries

@Composable

fun <T> PolarGraphScope<T>.PolarPlotSeries(data: List<PolarPoint<Float, T>>, modifier: Modifier = Modifier, lineStyle: LineStyle? = null, areaStyle: AreaStyle? = null, symbols: @Composable HoverableElementAreaScope.(PolarPoint<Float, T>) -> Unit? = null, animationSpec: AnimationSpec<Float> = KoalaPlotTheme.animationSpec)

Plots a series on a PolarGraph.

PolarPoint

fun <R, T> PolarPoint(r: R, theta: T): PolarPoint<R, T>

Creates a new DefaultPolarPoint at the specified coordinates.

rememberAngularValueAxisModel

@Composable

fun rememberAngularValueAxisModel(tickValues: List<AngularValue> = buildList { @Suppress("MagicNumber") for (i in 0..<8) { add((PI * i / 4.0).rad) } }, angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.COUNTERCLOCKWISE, angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.THREE_OCLOCK): AngularValueAxisModel

rememberCategoryAngularAxisModel

@Composable

fun <T> rememberCategoryAngularAxisModel(categories: List<T>, angleDirection: AngularAxisModel.AngleDirection = AngularAxisModel.AngleDirection.CLOCKWISE, angleZero: AngularAxisModel.AngleZero = AngularAxisModel.AngleZero.TWELVE_OCLOCK): CategoryAngularAxisModel<T>

Creates and remembers a CategoryAngularAxisModel.

rememberFloatRadialAxisModel

@Composable

fun rememberFloatRadialAxisModel(tickValues: List<Float>): FloatRadialAxisModel